Skip to content

🌱 certwatcher: add instance-specific logger with cert/key context #3293

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Aug 26, 2025
Merged

🌱 certwatcher: add instance-specific logger with cert/key context #3293

merged 1 commit into from
Aug 26, 2025
+11 −8

Conversation

s-z-z
Copy link
Contributor

@s-z-z s-z-z commented Aug 21, 2025

After manually updating a certificate, it’s unclear whether the target certificate was updated. This PR adds identification of the source certificate.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Aug 21, 2025
@k8s-ci-robot
Copy link
Contributor

Hi @s-z-z. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Aug 21, 2025
@k8s-ci-robot k8s-ci-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Aug 21, 2025
@sbueringer
Copy link
Member

Just curious. In which case was it necessary for you to distinguish which cert was "updated" at which time?

@s-z-z
Copy link
Contributor Author

s-z-z commented Aug 22, 2025

Hi, @sbueringer
I appreciate your curiosity about the changes in the PR.
My controller includes a total of three certWatchers, including metricCertWatcher.
After updating the certificate from the certificate issuer using a tool, I cannot tell from the logs whether the certificate I operated on was updated, because the logs for all certificate updates are the same.

sbueringer
sbueringer reviewed Aug 25, 2025
View reviewed changes
pkg/certwatcher/certwatcher.go
@@ -208,7 +208,7 @@ func (cw *CertWatcher) ReadCertificate() error {
return nil
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's create a logger for CertWatcher in ~ l.68 and then use that one everywhere instead

	cw := &CertWatcher{
		certPath: certPath,
		keyPath:  keyPath,
		interval: defaultWatchInterval,
		log:      log.WithValues("cert", certPath, "key", keyPath),
	}

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea, this simplifies similar changes in the future. As you suggested, I've updated the code.

@s-z-z s-z-z force-pushed the certwatcher-patch branch from 6cc0497 to 41feb4f Compare August 26, 2025 10:39
@k8s-ci-robot k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Aug 26, 2025
@s-z-z s-z-z changed the title 🌱 feat(certwatcher): Log source cert to distinguish multiple cert updates 🌱 feat(certwatcher): add instance-specific logger with cert/key context Aug 26, 2025
@sbueringer sbueringer changed the title 🌱 feat(certwatcher): add instance-specific logger with cert/key context 🌱 certwatcher: add instance-specific logger with cert/key context Aug 26, 2025
@sbueringer
Copy link
Member

Thx!

/ok-to-test

/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Aug 26, 2025
@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 26, 2025
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: d7a33b570bb5ab309b0e382e530900507ecf58cd

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: s-z-z, sbueringer

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 26, 2025
@k8s-ci-robot k8s-ci-robot merged commit e922805 into kubernetes-sigs:main Aug 26, 2025
20 checks passed
@s-z-z s-z-z deleted the certwatcher-patch branch August 26, 2025 14:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sbueringer sbueringer sbueringer left review comments

@troy0820 troy0820 Awaiting requested review from troy0820

@varshaprasad96 varshaprasad96 Awaiting requested review from varshaprasad96

Assignees

@sbueringer sbueringer

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@s-z-z @k8s-ci-robot @sbueringer